6.2.0 Values.yaml

You can use values.yaml or provide an over-rides file for bringing up a running Local Edition cluster using Helm. Edit values to provide different configurations required to deploy pods and services on Kubernetes. The entries affect all K8s resources, such as pods, containers, services, cron jobs, configmaps, and secrets.

note

When editing values.yaml or providing an over-rides file, ensure that no yaml rules are broken. An improper edit can prevent the application from being deployed successfully.

You can verify compliance of the YAML syntax by using the following command:

helm lint

You must review and modify the following properties:

Values.global.acceptEUA

• You must set the value to true before deploying the chart.

• Impacted templates:

  • cacheloader-deploy.yaml

  • configui-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

• Data type: boolean

• Default value: false

• Acceptable values: true and false.

Values.global.apimClusterMode

• Property to govern how the cluster will be deployed.

• Possible values: tethered and untethered. The values are case sensitive.

  In tethered mode, the cluster depends on the Boomi Cloud API Management for configuration and policies.

  Refer to the Mashery Onprem Manager (MOM) API key and Secret section in Other Secrets for more information.

• Impacted templates:

  • configui-configmap.yaml
  • loader-configmap.yaml
  • loader-job.yaml

• Data type: string

• Default value: untethered

Values.global.apimImageRegistry

• The FQDN or IP address of the image registry from which the application images are pulled. You must provide this value.

• Impacted templates:

  • cache-deploy.yaml

  • cacheloader-cronjob.yaml

  • cacheloader-deploy.yaml

  • configui-deploy.yaml

  • platformapi-deploy.yaml

  • startup-cacheloader-job.yaml

  • trafficmanager-deploy.yaml

• Data type: string

• Default value: -

• Acceptable values: Resolvable and reachable FQDN or IP address and optionally provide registry.

  For example - mycompany.harbor.com, mycompany.harbor.com/apimtrials

Values.global.imagePullSecrets

• Image pull secrets are created as a part of the pre-install checklist. This is required only for a secure image registry. If you are not using secure registries, leave the default value.

• Impacted templates:

  • cache-deploy.yaml

  • cacheloader-cronjob.yaml

  • cacheloader-deploy.yaml

  • configui-deploy.yaml

  • platformapi-deploy.yaml

  • startup-cacheloader-job.yaml

  • trafficmanager-deploy.yaml

• Data type: array

• Default value: []

• Acceptable values: An array of secret names declared in Kubernetes syntax.

  For example,imagePullSecrets:

  • name:secret1

  • name:secret2

Values.global.apimClusterName

• Cluster name is a unique identifier for the Local Edition instance. This value is important in instances where multiple Local Edition clusters share the same database.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • trafficmanager-deploy.yaml

  • Data type: string

• Default value: apiml1

• Acceptable values: It must be unique for each cluster sharing the same database.

Values.global.imagePullPolicy

• The image pull policy governs when the kubelet should pull images.

• Impacted templates:

  • cacheloader-deploy.yaml

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: string

• Default value: Always

• Acceptable values: IfNotPresent, Always, and Never

Values.global.securityContext.runAsUser

• Local Edition images has the default user: nonroot - 65532.

  You can change the value based on your organization's policies. This is a good security practice.

  caution

  • Refrain from using user 0.

  • OpenShift users must provide a value based on their OpenShift policies. In general, OpenShift expects larger values enforced by dynamic range - generally between 1000000000 and 2000000000. Refer tosa.scc.uid-range for OpenShift project.

• Impacted templates:

  • cacheloader-deploy.yaml

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: integer

• Default value: 10001

• Acceptable values: Any integer only within the range 1 to 65535. Check the clusters' SCC setting for range.

Values.global.securityContext.runAsGroup

• Local Edition images has the default group: nonroot - 65532.

  You can change the value based on your organization policies. This is a good security practice.

  caution

  • Refrain from using user 0.

  • OpenShift users must provide a value based on their OpenShift policies. In general, OpenShift expects larger values enforced by dynamic range - generally between 1000000000 and 2000000000. Refer to sa.scc.uid-range for OpenShift project.

• Impacted templates:

  • cacheloader-deploy.yaml

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: integer

• Default value: 10001

• Acceptable values: Any integer only within the range 1 to 65535. Check the clusters' SCC setting for the range.

Values.global.securityContext.openshiftDeployment

• In case of OpenShift deployment, you must set this value to true.

• Impacted templates:

  • cacheloader-deploy.yaml

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: boolean

• Default value: false

• Accepted values: true and false

Values.global.mysqlDatabase.host

• This is a host name, IP address, or managed service database instance's FQDN.

• Impacted templates:

  • platformapi-configjson-configmap.yaml

  • cacheloader-configmap.yaml

  • trafficmanager-configmap.yaml

  • configui-configmap.yaml

• Data type: string

Values.global.mysqlDatabase.port

• The port number on which the database is listening for client connections.

• Impacted templates:

  • platformapi-configjson-configmap.yaml

  • cacheloader-configmap.yaml

  • trafficmanager-configmap.yaml

  • configui-configmap.yaml

• Data type: integer

• Default value: 3306

• Acceptable value: Port number

Values.global.mysqlDatabase.sslMode

• This setting informs whether you want to communicate with the database via TLS. Refer to Securing Connections to an External MySQL 8 compliant database for more information.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: string

• Default value: disable

• Acceptable values: disable, trust, verify-ca, verify-full

Values.global.mysqlDatabase.mutualTls

• This setting informs clients if they have to use mTLS to access the database. Refer to Securing Connections to an External MySQL 8 compliant database for more information.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: string

• Default value: disable

• Acceptable values: enable and disable

Values.global.mysqlDatabase.connectTimeout

• Time in seconds the database server waits for a client connection to send more data before aborting the read operation.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: integer or long

• Default value: 4000

Values.global.mysqlDatabase.netReadTimeout

• Time in seconds to wait on writing a block to a connection before aborting the write. It also defines how long the database server waits for the client to retrieve the entire result set.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: integer or long

• Default value: 30

Values.global.mysqlDatabase.netWriteTimeout

• Defines the network socket timeout (SO_TIMEOUT) in milliseconds. Value of 0 (default) disables this timeout.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: integer or long

• Default value: 360

Values.global.email.mail.transport.protocol

• The protocol represents the system for notifying users. Refer to the comments in the values.yaml for additional settings for each protocol.

• Impacted templates:

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: string

• Default value: log

• Acceptable values: aws, smtp, and log.

Values.global.localDevAdminUser

• Property is used by ConfigUI to bootstrap the authentication flow. We recommend changing this value.

• Impacted templates:

  • configui-configmap.yaml
  • loader-deploy.yaml

• Data type: string

• Default value: admin

Values.global.localDevOAuthScope

• Property is used by ConfigUI to restrict data access to a particular area.

• The value for this property is dependent on apimClusterMode. If apimClusterMode is untethered, you must generate the value using the customize script. If tethered, you can use the value you get after signing in to the Boomi Cloud API Management Cloud Control Center.

• Impacted templates:

  • configui-configmap.yaml
  • preinstall-job.yaml

• Data type: string UUID

• Default value: none

  Refer to Customising IDs and Keys for Local Edition for more information.

Values.global.k8sServiceType

• Property that allows Kubernetes services of a particular type.

• Impacted templates:

  • trafficmanager-svc.yaml

  • platformapi-svc.yaml

  • configui-svc.yaml

  • cacheloader-svc.yaml

  • cache-svc.yaml

• Data type: string

• Default value: LoadBalancer

• Acceptable values: LoadBalancer, NodePort, and ClusterIP.

Values.global.domainSuffix

• This is the domain that is provided when you customize seed data. The default value is mashery.com

• Impacted templates:

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • `configui-configimap.yaml``

• Data type: string

• Default value: mashery.com

• Acceptable values: The text should be in the form of domain_name.tld or domain_name. For example, mycompany.com or myorganization.org or mycompany or myorganization.

Values.global.proxyIni.networkaddressCacheTtl

• This is a Java security property that controls how long the JVM caches successful hostname lookups. Refer to Networking Properties (Java SE 17 & JDK 17) for more information.

• Default value: 0

Values.global.proxyIni.networkaddressNegativeCacheTtl

• Property controls the caching of failed lookups. Refer to Networking Properties (Java SE 17 & JDK 17) for more information.

• Default value: 0

  note

  Go to charts/platformapi/values.yaml and charts/trafficmanager/values.yaml files to update the Xmx and Xms values.

Values.proxyIni.Xmx

• The default value for this property is 1024m.

  note

  We recommend not changing the default values for Xmx. But, if you change Xmx to a higher value, ensure that Xms is also set to the same value as Xmx.

Values.proxyIni.Xms

• The default value for this property is 1024m.

  note

  We recommend not changing the default values for Xms. But, if you change Xms to a higher value, ensure that Xmx is also set to the same value as Xms.

Values.global.mom

important

This section represents a change from LE v6.1.0, where these properties were associated with the Loader chart.

• Property that controls the connection to the Mashery Onprem Manager (MOM) service, including proxy usage if enabled.

• Impacted templates:

  • loader-configmap.yaml

  • logsync-configmap.yaml

  • loader-deploy.yaml

  • logcollector-pod.yaml

Optional Properties

note

The following properties are optional.

Values.global.mom.proxy.enabled

• This enables or disables proxy usage for MOM connections.

• Data type: boolean

• Default value: false

Values.global.mom.proxy.host

• This is the proxy host address when the proxy is enabled.

• Data type: string

• Default value: ""

Values.global.mom.proxy.port

• This is the proxy port number when the proxy is enabled.

• Data type: string

• Default value: ""

Values.global.mom.proxy.auth.enabled

• This enables proxy authentication. If authentication is enabled, the credentials must be provided as secrets. Refer to Creating HTTP Proxy Secrets (introduced in v6.2.0) in Other Secrets for more information.

• Data type: boolean

• Default value: true

Values.global.logging.includeFluentBitContainer

The Fluent Bit side car on K8s requires specific capabilities. If your security settings do not allow it, disable fluent-bit.

caution

OpenShift imposes further restrictions that do not allow Fluent Bit to access console logs of the pods. For OpenShift, you can either disable Fluent Bit or allow Fluent Bit to access the log file on the pod. Refer to Values.global.logging.appLogLocation for more information.

• Property controls the deployment of the Fluent Bit sidecar. When set to false, it excludes the Fluent Bit container sidecar.

• Possible values: true | false When set to false, it will output logs to the primary container console. In such case, you must configure logging agents to send logs to the observability stack.

• Data type: boolean

• Default value: true

Values.global.logging.appLogLocation

• Property is used to configure the Application log destination.

• Data type: string

• Default value: console

• Possible values: console | filesystem. These values are case sensitive.

  When set to console, it emits the logs to the Fluent Bit container console. Kubelet manages the logs. If it is set to fliesystem, logs are written to a temp file inside the pod. Fluent-bit tails this file to stream the logs.

  warning

  In filesystem mode, logs are not retained when the pod restarts. You may also notice performance degradation and higher resource utilization.

  In either mode, logs are still available on the primary container console.

Values.global.logging.filesystem.rollovertrigger.maxFileSize

• Property to configure the file rollover file size trigger.

• Value is in Megabytes(MB)

• Applicable only if appLogLocation is set to filesystem.

• Data type: integer

• Default value: 20

• Possible value: Any integer greater than zero. The value is specified in MB.

  warning

  Do not set it to a very high value, as this will result in higher disk utilization.

Values.global.logging.filesystem.rollovertrigger.totalFileSizeCap

• Property to define the total archive file cap size.

• Possible value: Any integer greater than 0.

• Value is in Gigabytes(GB).

• Applicable only if appLogLocation is set to filesystem.

• Data type: integer

• Default value: 1

warning

Do not set it to a high value, as this will result in higher disk utilization.

Values.global.logging.filesystem.retentionPolicy.maxFiles

• Property to define how many archive files can be retained. The rolled over files are gzipped. Older files are deleted when the maximum number of files is reached.

• Possible value: Any integer greater than 0.

• Applicable only if appLogLocation is filesystem.

• Data type: integer

• Default value: 10

warning

Do not set it to a high value, as this will result in higher disk utilization.

Values.global.logging.filesystem.retentionPolicy.maxAge

• Property to define how long archive files have to be retained. The rolled over files are gzipped. Older files are deleted when the maximum number of days are reached.

• Possible value: Any integer greater than 0

• Applicable only if appLogLocation is filesystem

• Data type: integer

• Default value: 28

warning

Do not set it to a high value, as this will result in higher disk utilization.

Values.global.logging.filesystem.logDirectory

• Property to configure the file destinations(directory) for log files.

• Possible value: Any string denoting a directory path (full path). The value is a full path or a relative path. Relative path results in errors.

• Data type: string (Directory path).

  caution

  Do not add / at the end.

• Default value: /tmp/logs

  warning

  Use only /tmp as the root directory.

Values.preInstallDBPrep.populateSeedData

• Property determines whether the database should be populated with seed data. It is needed only for the first time. Set the value to yes, if you are installing this for the first time.

• Possible values: true|false|yes\no|True|False|Yes|No|TRUE|FALSE|YES|NO

• Impacted Templates: preinstall-job.yaml

• Data type: string

• Default value: No

Values.preInstallDBPrep.apiKey

• Property defines API key for ConfgUI to call Platform API REST resources.

• Impacted templates: preinstall-job.yaml

Values.preInstallDBPrep.localDevAdminPassword

• Property that allows to change the password.

  note

  You must change your password. For security reasons, we recommend providing this value in the command line (helm install) while installing the application. Refer to 6.2.0: Installing Local Edition section for more information.

Values.trafficmanager.replicas

• Property that allows Helm (and Kubernetes) to scale the trafficmanager. Set the value and run helm upgrade.

• Impacted template: trafficmanager-deploy.yaml

• Data type: integer

• Default value: 1

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.platformapi.replicas

• Property that allows Helm (and Kubernetes) to scale platformapi. Set the value and run helm upgrade.

• Impacted template: platformapi-deploy.yaml

• Data type: integer

• Default value: 1

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.configui.replicas

• Property that allows Helm (and Kubernetes) to scale the configui. Set the value and run helm upgrade.

• Impacted template: configui-deploy.yaml

• Data type: integer

• Default value: 1

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.cacheloader.replicas

• Property that allows Helm (and Kubernetes) to scale the cacheloader. Set the value and run helm upgrade.

• Impacted template: cacheloader-deploy.yaml

• Data type: integer

• Default value: 1

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.cache.replicas

• Property that allows Helm (and Kubernetes) to scale the cache. Set the value and run helm upgrade.

• Impacted template: cache-deploy.yaml

• Data type: integer

• Default value: 3

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.logcollector.replicas

• Property that allows Helm (and Kubernetes) to scale the logcollector. Set the value and run helm upgrade.

• Impacted template: logcollector-pod.yaml

• Data type: integer

• Default value: 1

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.trafficmanager.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template: trafficmanager-deploy.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.platformapi.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template: platformapi-deploy.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.loader.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template: cacheloader-deploy.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.loadercron.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template:

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.loadercron.onpremLoad.schedule

• Impacted template: loader-cronjob.yaml
• Data type: string
• Acceptable values: A cron tab expression. For example to start every 12 minutes: */12 * * * *

note

Adjust this cron carefully in multi-cluster deployments to avoid simultaneous database writes. For safe scheduling across clusters, refer to the Loader Scheduling Guidelines for Shared Database Clusters section in Cluster Design Guide.

Values.loadercron.fullLoad.schedule

• Impacted template: loader-cronjob.yaml
• Data type: string
• Acceptable values: A cron tab expression. For example to start every 12 minutes: */12 * * * *

Values.loadercron.deltaLoad.schedule

• Impacted template: loader-cronjob.yaml
• Data type: string
• Acceptable values: A cron tab expression. For example to start every 12 minutes: */12 * * * *

Values.cache.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template: cache-deploy.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.fluentbit.tag

• Local Edition uses Fluent Bit 2.2.1

• Impacted template:

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: string

• Default value: 2.2.1

• Acceptable values: Alpha-numeric without spaces and no special characters.

  caution

  Do not make any changes without consulting the Boomi Account Representative.

Values.fluentbit.image

• Local Edition uses Fluent Bit official image fluent/fluent-bit from DockerHub.

• Impacted templates:

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: string

• Default value: fluent/fluent-bit

• Acceptable values: Alpha-numeric without spaces and no special characters.

  caution

  Do not make any changes without consulting the Boomi Account Representative.

Values.trafficmanager.externalTrafficPolicy

• Property that governs how the HTTP request client IP is handled by Kubernetes.
• It is applicable only if Values.global.k8sServiceType is Load Balancer.
• Default value: Cluster
• Acceptable values: Local or Cluster

warning

Using the value Local in the externalTrafficPolicy parameter impacts load balancing. We recommend creating an external Load Balancer and passing the X-Forwarded-For header in the request. Refer to the Caveats and limitations when preserving source IPs section for more information.

Values.loader.serviceLoadThrottlePeriod

• Property allows the loader to provide throttle delay every serviceLoadThrottlePeriod milliseconds when both serviceLoadThrottlePeriod and serviceLoadThrottleDelay are set to values greater than zero.

• There is an interval in milliseconds between batches of service loading during startup.

• Impacted templates:

  • loader-configmap.yaml

  • loader-deploy.yaml

• Data type: integer

• Default value: 1000

Values.loader.serviceLoadThrottleDelay

• Initial delay before loading services. This allows a grace period for previous jobs to finish if one is running.

• Initial delay (in milliseconds) before service loading starts.

• Impacted templates:

  • loader-configmap.yaml
  • loader-deploy.yaml

• Data type: integer

• Default value: 100

datasource.pool.maxActive

Values.trafficmanager.datasource.pool.maxActive

important

The default values for these attributes are sufficient for most cases. Update these values when you notice database connection time or query timeout errors. If you have any questions, consult the Boomi Account Representative.

• Property that controls the maximum number of active connections to be maintained in the pool.

• Impacted template: trafficmanager-deploy.yaml

• Data Type: integer

• Default Value: 8

• Acceptable value: Any positive integer. Value depends on the number of connections that the database currently supports.

Values.loader.datasource.pool.maxActive

• Property that controls the maximum number of active connections to be maintained in the pool.

• Impacted template: loader-deploy.yaml

• Data Type: integer

• Default Value: 8

• Acceptable value: Any positive integer. Value depends on the number of connections that the database currently supports.

Values.platformapi.datasource.pool.maxActive

• Property that controls the maximum number of active connections to be maintained in the pool.

• Impacted template: platformapi-deploy.yaml

• Data Type: integer

• Default Value: 8

• Acceptable value: Any positive integer. Value depends on the number of connections that the database currently supports.

Values.configui.datasource.pool.maxActive

• Property that controls the maximum number of active connections to be maintained in the pool.

• Impacted template: configui-deploy.yaml

• Data Type: integer

• Default Value: 8

• Acceptable value: Any positive integer. Value depends on the number of connections that the database currently supports.

Values.logcollector.datasource.pool.maxActive

• Property that controls the maximum number of active connections to be maintained in the pool.

• Impacted template: logcollector-pod.yaml

• Data Type: integer

• Default Value: 8

• Acceptable value: Any positive integer. Value depends on the number of connections that the database currently supports.

datasource.pool.minIdle

Values.trafficmanager.datasource.pool.minIdle

• Property that controls the minimum number of active connections to be maintained in the pool.
• Impacted template: trafficmanager-deploy
• Data Type: integer
• Acceptable values: Any positive integer. Value depends on the number of connections that the Database currently supports.

Values.loader.datasource.pool.minIdle

• Property that controls the minimum number of active connections to be maintained in the pool.

• Impacted template: loader-deploy

• Data Type: integer

• Acceptable values: Any positive integer. Value depends on the number of connections that the Database currently supports.

Values.platformapi.datasource.pool.minIdle

• Property that controls the minimum number of active connections to be maintained in the pool.

• Impacted template: platformapi-deploy

• Data Type: integer

• Acceptable values: Any positive integer. Value depends on the number of connections that the Database currently supports.

Values.configui.datasource.pool.minIdle

• Property that controls the minimum number of active connections to be maintained in the pool.

• Impacted template: configui-deploy

• Data Type: integer

• Acceptable values: Any positive integer. Value depends on the number of connections that the Database currently supports.